/*
 * Copyright (c) 2008-2011, Matthias Mann
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Matthias Mann nor the names of its contributors may
 *       be used to endorse or promote products derived from this software
 *       without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package de.matthiasmann.twl.model;

/**
 *
 * @author Matthias Mann
 */
public interface EditFieldModel extends ObservableCharSequence {

    /**
     * Replace {@code count} characters starting at {@code start} with the
     * specified {@code replacement} text.
     * @param start the start index
     * @param count the number of characters to replace, can be 0.
     * @param replacement the replacement text, can be empty.
     * @return the number of characters which have been inserted, or -1 if
     *         no replacement has been performed.
     * @throws StringIndexOutOfBoundsException if {@code start} or {@code count}
     *         are outside the sequence
     * @throws NullPointerException when replacement is {@code null}
     */
    public int replace(int start, int count, String replacement);

    /**
     * Replace {@code count} characters starting at {@code start} with the
     * specified {@code replacement} character.
     * @param start the start index
     * @param count the number of characters to replace, can be 0.
     * @param replacement the replacement character
     * @return true if the sequence was changed, false otherwise.
     * @throws StringIndexOutOfBoundsException if {@code start} or {@code count}
     *         are outside the sequence
     */
    public boolean replace(int start, int count, char replacement);

    /**
     * Returns a String containing the specified range from this sequence.
     * @param start the start index
     * @param end the end index
     * @return the String object
     * @throws StringIndexOutOfBoundsException if {@code start} or {@code count}
     *         are outside the sequence
     * @see #subSequence(int, int)
     */
    public String substring(int start, int end);
}
